Process/Instances({ProcessInstanceID})

Returns a single process instance for the matching ProcessInstanceID.

  Value Notes
URI {Service Root URI}/Process/Instances({ProcessInstanceID})
e.g.
https://api.denallix.com:443/K2Services/REST.svc/Process/Instances(5)
  • {ProcessInstanceID } is a Integer and is the identifier of the process instance
  • Custom Query Options – by default worklist item detail data will not be returned.  Changing either the service configuration (web.config) or providing these query options can override whether detail data.
      • piDataField (Boolean) – determines if process level data fields should be returned
      • piXmlField (Boolean) – determines if process level XML fields should be returned
  • Optional Query Options:
    System Query Options
Method GET  
Return Type

ProcessInstance or Failure

  
Return Example <ProcessInstance ExpectedDuration="60" Folder="K2 Examples" Folio="Order-ACME-Updated" FullName="K2 Examples\Order Process" Guid="b8cf5da7-7cf9-4af2-abc6-7fb91a69354c" ID="8" Name="Order Process" Priority="1" StartDate="2011-02-16T04:52:47.687Z" Status="Active"
    xmlns="http://schemas.k2.com/worklist/d1"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Description
        xmlns="http://schemas.k2.com/process/d1"/>
        <Metadata
            xmlns="http://schemas.k2.com/process/d1">Blank
        </Metadata>
        <DataField Name="MyProcessDataField"
            xmlns="http://schemas.k2.com/process/d1">Some process data value
        </DataField>
        <XmlField Name="MyProcessXMLField"
            xmlns="http://schemas.k2.com/process/d1">
            <XmlDocument>Some Process XML document</XmlDocument>
        </XmlField>
</ProcessInstance>
 

K2 blackpearl Developers Reference4.7
Video Links Learn Support
No videos found for this article
K2 on YouTube
No Additional links found for this article
No self-learning content for this article
Try some scenarios...
No relevant support links available for this article